home *** CD-ROM | disk | FTP | other *** search
/ Cream of the Crop 26 / Cream of the Crop 26.iso / bbs / time20.zip / TIME20.EXE / EPMCODE / EPMCODE.DOC < prev    next >
Text File  |  1997-08-23  |  10KB  |  187 lines
  1.  
  2.                      Time Travel - EPM CODING INFORMATION
  3.                    (C)Copyright  1996-97 Sunrise Door Software
  4.  
  5.  ────────────────────────────────────────────────────────────────────────────
  6.   ALL data files are stored in the main Time Travel directory.  TTDAT.DAT is 
  7.   created in this directory as well. 
  8.  ────────────────────────────────────────────────────────────────────────────
  9.  
  10.  ────────────────────────────────────────────────────────────────────────────
  11.        Here is a list of files that should be included with TTCODE.EXE
  12.  ────────────────────────────────────────────────────────────────────────────
  13.   
  14.   TTDAT.DAT    - Sample of the TTDAT.DAT drop file created for player
  15.                  information.
  16.   TTCODES.TXT  - List of all color codes which can be used on description 
  17.                  line at the [J]ump To Other Places Menu.
  18.   DOORSYS.TXT  - Sample Time Travel created DOOR.SYS file.
  19.   DHDAT.TXT    - Format of daily happenings data file.
  20.   JUMPS.DAT    - Sample EPM data file.
  21.   EPMCODE.DOC  - This text file.
  22.  
  23.  ────────────────────────────────────────────────────────────────────────────
  24.   
  25.   Time Travel creates 2 files called: 
  26.  
  27.           TTDAT.DAT
  28.           DOOR.SYS
  29.  
  30.   when a caller uses an EPM.  These files can be used by 3rd party programmers 
  31.   to create their own add ons for Time Travel.  
  32.  
  33.                               
  34.  ────────────────────────────────────────────────────────────────────────────
  35.                               THE DOOR.SYS FILE
  36.  ────────────────────────────────────────────────────────────────────────────
  37.   
  38.   Basically what Time Travel does is copy the DOOR.SYS file it is using to
  39.   the main Time Travel directory.  At the time that the EPM is run it copies
  40.   the DOOR.SYS file over and changes the amount of time the user has left to
  41.   the CURRENT amount of time left as opposed to the amount of time left when
  42.   the user first entered Time Travel.  The format for the DOOR.SYS file is 
  43.   EXACTLY as any door programmer has been accustomed to because of this.  It
  44.   is the standard 52 line DOOR.SYS file.  NEVER READ THE DOOR.SYS CREATED BY
  45.   THE BBS...ONLY THIS ONE WHICH WILL RESIDE IN THE MAIN TIME TRAVEL DIRECTORY.
  46.   Think of the main Time Travel directory as the BBS drop file directory.  If
  47.   you DO NOT read THIS DOOR.SYS file, then the users time will not be adjusted
  48.   properly.
  49.                               
  50.  ────────────────────────────────────────────────────────────────────────────
  51.                               THE TTDAT.DAT FILE
  52.  ────────────────────────────────────────────────────────────────────────────
  53.   
  54.   The TTDAT.DAT file does NOT contain information that your EPM may need
  55.   to actually "operate."  This file contains all of the info of the players
  56.   record who is using the EPM.
  57.  
  58.  ────────────────────────────────────────────────────────────────────────────
  59.   
  60.   The TTDAT.DAT file makes it a snap to write EPM's for Time Travel!  All
  61.   of the players information is contained in this text file for you!
  62.  
  63.          ->  Setup a routine in your EPM that reads the players info from
  64.              the TTDAT.DAT file, and a routine that writes any changes that
  65.              your EPM makes to the players info, back to the TTDAT.DAT file, 
  66.              so that Time Travel can make the appropriate changes if any.
  67.              If changes are made, you will ADD to the totals in the TTDAT.DAT
  68.              file.  ie. Players Time Jumps as written in the TTDAT.DAT file
  69.              when Time Travel shells out to run your EPM is set at 10 and
  70.              you somehow give the player an extra 5 jumps, the value written
  71.              back to the TTDAT.DAT file would be the original amount plus
  72.              your amount [15].
  73.  ────────────────────────────────────────────────────────────────────────────
  74.  
  75.   How it works:
  76.   ------------
  77.   
  78.   When running an EPM, Time Travel creates the 2 files described above.
  79.   After gathering the COM port info, and/or whatever other info you may
  80.   need to operate your EPM from the DOOR.SYS file, you need to read in the 
  81.   player info from the TTDAT.DAT file and save the values to your own 
  82.   variables. 
  83.   
  84.   After your EPM is finished, just before exiting back to the game, your EPM 
  85.   MUST rewrite the TTDAT.DAT file, using the new values (if any). When Time 
  86.   Travel reloads, it reads the TTDAT.DAT file, and saves all of the values 
  87.   therein to the players record. You MUST change line 1 in this file to 
  88.   "YES" if you want Time Travel to record the changes in this file to the 
  89.   players record!
  90.  
  91.   If there are NO changes to be made to the players record, then you don't
  92.   have to even touch the TTDAT.DAT file.  If the first field still contains
  93.   NO when Time Travel swaps back in, then the file will be ignored.
  94.  
  95.   Things to keep in mind: 
  96.   ----------------------
  97.   
  98.   1) You MUST change line 1 to read YES if you have modified the TTDAT.DAT
  99.      file in any way.  If it reads NO, Time Travel will IGNORE the entire
  100.      file.
  101.   
  102.   2) You MUST write ALL of the info back to the TTDAT.DAT file! Even if you
  103.      only make changes to a few values!  When Time Travel reads info from
  104.      the TTDAT.DAT file, if it finds ANY problems in the format (strings 
  105.      where numerals were expected, etc.), then it will completely IGNORE the 
  106.      info contained in the file.
  107.  
  108.   3) BE CAREFUL! Inserting the wrong value in an improper line number of
  109.      the TTDAT.DAT file when your EPM finishes, can have unpredicted
  110.      results (if Time Travel accepts the mistake for some reason). For 
  111.      example, putting the users amount of Money in the bank on the line that 
  112.      is supposed to contain the players fights left for the day...be careful
  113.      not to do things like this. Try to make sure you follow the exact
  114.      format shown in the example TTDAT.DAT file when writing your values
  115.      back to the file.
  116.  
  117.   4) Do NOT use commas in your large amounts! If you do, then ALL of the
  118.      info in the TTDAT.DAT file will NOT be the proper value. For example, if 
  119.      the player leaves your EPM with $200,120 , write it to the TTDAT.DAT file
  120.      as 200120, not 200,120.  Time Travel will see the latter amount as $200
  121.      dollars because the field will be truncated at the comma!
  122.  
  123.   5) At this time, Time Travel is NOT multinode.  So making your EPM
  124.      multinode is NOT neccessary.  There are NO immediate plans for a
  125.      multinode version either.
  126.  ────────────────────────────────────────────────────────────────────────────
  127.               
  128.               
  129.  ────────────────────────────────────────────────────────────────────────────
  130.               WHAT YOUR EPM HAS TO HAVE TO BE CONSIDERED AN EPM:
  131.  ────────────────────────────────────────────────────────────────────────────
  132.      
  133.   1) It MUST have an easy to use INSTALL program.  It should place the name
  134.      of the EPM and the BATCH file in the JUMPS.DAT file automatically.  The
  135.      Sysop should not have to do this manually.  Make it so it creates the
  136.      neccessary BATCH file and places it in the main Time Travel directory
  137.      for them or at least include a sample BATCH file for the Sysop.  It MUST 
  138.      also have an UNINSTALL program.  This program should delete all of the
  139.      files from their hard drive, take out your EPM information in their
  140.      JUMPS.DAT file and delete the BATCH file from their Time Travel 
  141.      directory.
  142.  
  143.      
  144.  ────────────────────────────────────────────────────────────────────────────
  145.                       IMPORTANT THINGS TO KEEP IN MIND:
  146.  ────────────────────────────────────────────────────────────────────────────
  147.  
  148.  1) Don't charge more for your EPM than the purchase price of Time Travel.
  149.     If you want to make your EPM FREEWARE...Great!
  150.  
  151.  2) Don't give HUGE amounts of anything to the player.  It's no fun if the
  152.     player has 5,000,000 dollars!
  153.  
  154.  3) If you would like my official endorsement for your EPM, then send me
  155.     a registered copy of the EPM to test thoroughly.  I will release a 
  156.     list of EPM's that I suggest the Sysop obtain and where to get them.
  157.     Only those who have followed the above will make it on this list.
  158.  
  159.  4) Try to keep it simple.  The simpler the EPM, the quicker the game and the 
  160.     more apt the users are to stay interested.  An EPM that takes as long or 
  161.     longer than the main game to play is not an accent to the game..it IS a 
  162.     game!
  163.  
  164.  5) Take a long look at the overall game so you can get a feel for the way it 
  165.     operates.  Your EPM should not be EXACTLY like the game, but similarities 
  166.     in the way it works will help the user feel comfortable.
  167.  
  168.  6) Be creative.  The overall theme of the game lends itself to just about
  169.     anything you can think of when it comes to time travel.  The things that
  170.     could be explored are just about limitless.
  171.  
  172.  7) Test your EPM thoroughly.  Make sure it works before releasing it.  Do
  173.     all the strange and weird things you think the user might do and then
  174.     do some more even weirder things.  It's amazing what trouble a user and
  175.     even a Sysop can get into!
  176.  
  177.  ────────────────────────────────────────────────────────────────────────────
  178.  
  179.  That should be about it.  Make sure you read ALL of the information provided
  180.  in the files contained in this archive.  It took awhile to put this package
  181.  together and it is all here for a reason.
  182.  
  183.  Most of all...Have fun!  I know I tend to take programming a little too
  184.  seriously...I mean, look at these doc's, right?  Remember, Time Travel is
  185.  a GAME and your EPM is one too!
  186.  
  187.